au PAY（ネット支払い）
アプリ方式

au PAY（ネット支払い）アプリ方式 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranAupayApp 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

JobCd jobCd 必須
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount amount 必須 半角数字7桁
利用金額

利用金額+税送料で1円～300,000円設定可能
税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

Tax tax 半角数字7桁
税送料

利用金額+税送料で1円～300,000円設定可能
税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

URL
/payment/EntryTranAupayApp.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}
URL
/payment/EntryTranAupayApp.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "accessID":"a6a6b0061347e90cdef806b39bd28705",
    "accessPass":"5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranAupayApp 決済実行

これ以降の決済取引で必要となるワンタイムコードを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3

URL
/payment/ExecTranAupayApp.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}
URL
/payment/ExecTranAupayApp.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値をを返却します。

Status status 必須
現状態

対象取引の取引状態を返却します。
・REQSUCCESS：要求成功

OneTimeQRCode oneTimeQRCode 必須 半角英数63桁
QRコード用ワンタイムコード

加盟店様がau PAY サイトにアクセスする際に必要となるワンタイムコードを返却します。

GwJgyshaCd gwJgyshaCd 必須 半角数字5桁
GW 事業者コード

加盟店様がau PAY サイトにアクセスする際に必要となるGW事業者コードを返却します。

SeqNo seqNo 必須 半角英数64桁
シーケンス番号

加盟店様がau PAY サイトにアクセスする際に必要となるシーケンス番号を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "OrderID": "ORDER0000001",
    "Status": "REQSUCCESS",
    "OneTimeQRCode": "3158992128215581800000001CNH0537O00001000D49121210000041100000F",
    "GwJgyshaCd": "12345",
    "SeqNo": "59c86c3d2cc366d862ebc162b4038d5d92bb8bef01777b7db08c213a5ba194f4"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=REQSUCCESS&OneTimeQRCode=3158992128215581800000001CNH0537O00001000D49121210000041100000F&GwJgyshaCd=12345&SeqNo=59c86c3d2cc366d862ebc162b4038d5d92bb8bef01777b7db08c213a5ba194f4
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

au PAYサイトへの接続

加盟店サイトからau PAYサイトへ接続します。
※テスト環境ではau PAYサイトへの接続は行えません。現状態を仮売上または即時売上にする場合、管理画面からテスト入金を行ってください。操作方法は管理画面操作マニュアル1.2.6の章をご確認ください。

リクエストクエリパラメータ
onetmQrCd 必須 半角英数63桁 固定
ワンタイムコード(QR コード)

当サービスを通して KDDI 決済処理システムより払い出される動的ワンタイムコードを指定します。
【決済実行】で返却されたOneTimeQRCodeの値を設定してください。
callback 必須 半角英数記号256桁
決済完了コールバック URL

決済完了通知としての戻し先を指定します。
merchantName 必須 全半角数字150桁
QR 決済加盟店名

加盟店名を指定します。
動的MPMの表示用パラメータであり、アプリコールの場合は使用されません。
storeName 必須 全半角数字150桁
QR 決済店舗名

店舗名を指定します。
動的MPMの表示用パラメータであり、アプリコールの場合は使用されません。
payAmt 必須 半角数字7桁
決済金額

決済金額を表示します。
実際の決済金額はワンタイムコードに包含されており、このパラメータは表示用です。
動的MPMの表示用パラメータであり、アプリコールの場合は使用されません。
gwJgyshaCd 必須 半角数字7桁
GW 事業者コード

GW 事業者コードを指定します。
【決済実行】で発行されたGwJgyshaCdの値を設定してください。
seqNo 必須 半角英数字64桁
シーケンス番号

当サービスが発行する取引を一意に特定する番号です。
【決済実行】で発行されたSeqNoの値を設定してください。

商用環境：リクエストURI
https://wallet.auone.jp/netpay/payment
リクエストパラメータ
https://[ドメイン]/netpay/payment?onetmQrCd=0000000138215581800000001VI64HJFJ00000100D00000000000031900000F&callback=https://www.example.com/&merchantName=merchantName&storeName=storeName&payAmt=100&gwJgyshaCd=00000&seqNo=000000c3eee759a62d39ec753591bd1784ca75fc34f7c3a4095d460026ac6281
当サービスからの決済完了通知

au PAYの決済結果を結果通知で通知します。結果通知仕様はこちらをご確認ください。

au PAYからの決済完了通知

au PAYの決済結果を決済完了コールバック URLに通知します。

resultCd 半角英字4桁
結果コード
  • 001：決済が完了しました。
  • 002：決済が完了しました。(クーポンはご利用いただけませんでした。)
  • 101：決済が中断されました。
  • 202：決済が失敗しました。

注意

au PAY アプリの決済処理でタイムアウトが発生した場合は、結果コード設定が出来ないためにコールバック URLの呼出しはされません。
当サービスとau PAYから決済完了通知が行われますが、決済処理の実行成否は、当サービスからの決済完了通知 を常に正としてください。
au PAYからの決済完了通知を正とする場合、当サービスの決済状態と不整合が発生する場合がございます。

レスポンスパラメータ
https://www.example.com/?resultCd=001

AupayAppCancelReturn キャンセル・返品

対象の取引をキャンセルします。実売上または即時売上状態の取引は一部返金が可能です。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

仮売上、実売上、即時売上時の合計利用金額と一致する金額を設定するとキャンセルします。

（一部キャンセルを行いたい場合）
キャンセルしたい金額を設定します。
設定した金額がお客様に返金され、差額は実売上、即時売上の状態のままとなります。
例）
　実売上時の利用金額 = 1000円
　設定した利用金額 ＝ 200円
上記の条件でキャンセルを行った結果
　売上金額 = 800円
　キャンセル金額 = 200円

CancelTax cancelTax 半角数字7桁
キャンセル税送料

URL
/payment/AupayAppCancelReturn.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "200"
}
URL
/payment/AupayAppCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=200
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。

Status status 必須
現状態

対象取引の取引状態を返却します。
キャンセル・返品成功時は以下のステータスが返却されます。
・CANCEL：キャンセル
・RETURN：返品

Amount amount 必須 半角数字7桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

Tax tax 必須 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

対象取引でキャンセルした利用金額の累計を返却します。

CancelTax cancelTax 必須 半角数字7桁
キャンセル税送料

対象取引でキャンセルした税送料の累計を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "10"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=10
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AupayAppSales 実売上

仮売上の決済に対して実売上を行います。実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

Amount amount 必須 半角数字7桁
利用金額

対象決済の利用金額を指定してください。
取引の利用金額と一致しない場合エラーとなります。

Tax tax 半角数字7桁
税送料

対象決済の税送料を指定してください。
取引の税送料と一致しない場合エラーとなります。

URL
/payment/AupayAppSales.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "tax": "100"
}
URL
/payment/AupayAppSales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000&Tax=100
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。

Status status 必須
現状態

対象取引の取引状態を返却します。
・SALES：実売上

Amount amount 必須 半角数字7桁
利用金額

実売上した利用金額を返却します。

Tax tax 必須 半角数字7桁
税送料

実売上したを税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AupayAppChange 金額変更

仮売上取引に対して金額変更を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

Amount amount 必須 半角数字7桁
変更後利用金額

利用金額+税送料で1円～300,000円設定可能
税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

Tax tax 半角数字7桁
変更後税送料

利用金額+税送料で1円～300,000円設定可能
税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

URL
/payment/AupayAppChange.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}
URL
/payment/AupayAppChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を返却します。

Status status 必須
現状態

対象取引の取引状態を返却します。
・AUTH：仮売上
Amount amount 必須 半角数字7桁
変更後利用金額

変更後金額を返却します。

Tax tax 必須 半角数字7桁
変更後税送料

変更後金額を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "amount": "1000",
  "tax": "100"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=AUTH&Amount=1000&Tax=100
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeAupayApp/SearchTradeMulti 取引情報照会

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

PayType payType 半角数字2桁
決済方法

SearchTradeMultiをご利用の際は「52」を指定してください。
SearchTradeAupayAppをご利用の際は設定不要です。

URL
/payment/SearchTradeAupayApp.json
リクエストパラメータ
{
	"shopID": "tshop11223344",
	"shopPass": "PASSWORD",
	"orderID": "ORDER0000001"
  }
URL：SearchTradeAupayAppの場合
/payment/SearchTradeAupayApp.idPass
URL：SearchTradeMultiの場合
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=52
レスポンス
正常
Status status 必須
現状態
UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品
PAYFAIL：決済失敗
EXPIRED：期限切れ

ProcessDate processDate 必須 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd jobCd 必須
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品
EXPIRE：期限切れ
CHANGE：金額変更
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。
Amount amount 必須 半角数字7桁
利用金額

Tax tax 必須 半角数字7桁
税送料

ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
PayType payType 必須 半角数字2桁
決済方法

52：au PAY（ネット支払い）アプリ方式

AupayAppTranID aupayAppTranID 半角数字16桁 固定
au支払予約時のトランザクションID

決済完了またはキャンセル時にKDDIから発行される一意の番号です。

AupayAppVoucherNo aupayAppVoucherNo 半角数字19桁
au伝票番号

決済完了時にKDDIから発行される一意の番号です。
キャンセル時には発行されません。

AupayAppSeqNo aupayAppSeqNo 半角英数64桁
au支払予約時のシーケンス番号

auPay決済を行うために弊社で発行する番号です。

AupayAppCancelAmount aupayAppCancelAmount 必須 半角数字7桁
キャンセル金額

キャンセルした金額を返却します。

AupayAppCancelTax aupayAppCancelTax 必須 半角数字7桁
キャンセル税送料

キャンセルした税送料を返却します。

AupayAppIncreaseAmount aupayAppIncreaseAmount 必須 半角数字7桁
増額金額

増額した金額を返却します。

AupayAppIncreaseTax aupayAppIncreaseTax 必須 半角数字7桁
増額税送料

増額した税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
	"status": "AUTH",
	"processDate": "20220524134905",
	"jobCd": "AUTH",
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
	"amount": "1000",
	"tax": "100",
	"clientField1": "free1",
	"clientField2": "free2",
	"clientField3": "free3",
	"payType": "52",
	"aupayAppTranID": "0020220524134734",
	"aupayAppVoucherNo": "20220524134734690",
	"aupayAppSeqNo": "83bbe331ad983eb8e6ddebfdd377ef6575f2d5ff599101e72ceb14c22c518a26",
	"aupayAppCancelAmount": "0",
	"aupayAppCancelTax": "0",
	"aupayAppIncreaseAmount": "0",
	"aupayAppIncreaselTax": "0"
  }
レスポンスパラメータ：正常系
Status=AUTH&ProcessDate=20220524134905&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&ClientField1=free1&ClientField2=free2&ClientField3=free3&PayType=52&AupayAppTranID=0020220524134734&AupayAppVoucherNo=20220524134734690&AupayAppSeqNo=83bbe331ad983eb8e6ddebfdd377ef6575f2d5ff599101e72ceb14c22c518a26&AupayAppCancelAmount=0&AupayAppCancelTax=0&AupayAppIncreaseAmount=0&AupayAppIncreaseTax=0
レスポンスパラメータ：異常系
[
	  {
		  "errCode":"E01",
		  "errInfo":"E01040001" 
	  }
  ]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001